Add availability info for default heap dump path change #131713
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
shainaraskas
added
>docs
|
Pinging @elastic/es-docs (Team:Docs) |
🔍 Preview links for changed docs |
rjernst
reviewed
Jul 22, 2025
| By default, {{es}} configures the JVM to dump the heap on out of memory exceptions to the default logs directory. On [RPM](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-with-rpm.md) and [Debian](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-with-debian-package.md) packages, the logs directory is `/var/log/elasticsearch`. On [Linux and MacOS](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md) and [Windows](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-with-zip-on-windows.md) distributions, the `logs` directory is located under the root of the {{es}} installation. | ||
| Depending on your stack version, {{es}} configures the JVM to dump the heap on out of memory exceptions to the following location by default: | ||
|
|
||
| * {applies_to}`stack: ga 9.1` The default logs directory |
There was a problem hiding this comment.
this docs set only applies to 9.0+, but I agree that it is confusing. let me see if there's something I'm able to do.
There was a problem hiding this comment.
verified that we need to keep the 8.x and 9.x docs separate - this info should be manually backported into the asciidoc docs in the 8.19 branch.
will likely be doing a validation pass that the changes that are making it into 8.19 were appropriately ported but haven't gotten there yet :)
kilfoyle
reviewed
Jul 25, 2025
| @@ -139,9 +139,25 @@ If you are running {{es}} as a Windows service, you can change the heap size usi | |||
|
|
|||
| ## JVM heap dump path setting [heap-dump-path-setting] | |||
|
|
|||
| By default, {{es}} configures the JVM to dump the heap on out of memory exceptions to the default logs directory. On [RPM](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-with-rpm.md) and [Debian](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-with-debian-package.md) packages, the logs directory is `/var/log/elasticsearch`. On [Linux and MacOS](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md) and [Windows](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-with-zip-on-windows.md) distributions, the `logs` directory is located under the root of the {{es}} installation. | |||
| Depending on your stack version, {{es}} configures the JVM to dump the heap on out of memory exceptions to the following location by default: | |||
There was a problem hiding this comment.
Suggested change
| Depending on your stack version, {{es}} configures the JVM to dump the heap on out of memory exceptions to the following location by default: | |
| Depending on your {{stack}} version, {{es}} configures the JVM to dump the heap on out of memory exceptions to the following location by default: |
{[stack}} → Elastic Stack.
szybia
added a commit
to szybia/elasticsearch
that referenced
this pull request
Jul 25, 2025
…-tracking * upstream/main: (106 commits) Pipelines: Add `created_date` and `modified_date` (elastic#130847) add thread pool change availability (elastic#131734) Add failure store availability info / and port over privileges (elastic#131729) add availability information for ssl handshake timeout settings (elastic#131786) add availability information for rescore_vector (elastic#131710) add availability to oversample value of 0 (elastic#131707) clarify hnsw filter heuristic setting availability (elastic#131715) add availability info for default heap dump path change (elastic#131713) clarify default algorithms per stack version (elastic#131728) Refine error messages in `Fork` for correctness and clarity. (elastic#131701) [ES|QL] Replace RoundTo linear search evaluator with manual evaluators (elastic#131733) ESQL: Fix buildParams in tests with --configuration-cache (elastic#131826) Unmute `CrossClusterEsqlRCS2EnrichUnavailableRemotesIT#testEsqlEnrichWithSkipUnavailable` (elastic#131916) Allow templates for `.chat-*` index template (elastic#131914) ESQL: Fix NPE on empty to_lower/to_upper call (elastic#131917) Fix score computation in ES91Int4VectorsScorer (elastic#131905) Register a blob cache long counter metric for total evicted regions (elastic#131862) Move plan attribute resolution to its own component (elastic#131830) Make restore support multi-project (elastic#131661) Use logically more correct expression (elastic#131869) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Followup to #124966
This PR adds availability information for the change to the default jvm heap dump path. used tabs to provide detailed path information for both logs and data
Docs are now cumulative, which means that we need to clearly tag changes introduced in each version going forward, and keep docs valid for users still using older versions.